/*
 * ------------------------------------------------------------------------
 *  Copyright by KNIME AG, Zurich, Switzerland
 *  Website: http://www.knime.com; Email: contact@knime.com
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License, Version 3, as
 *  published by the Free Software Foundation.
 *
 *  This program is distributed in the hope that it will be useful, but
 *  WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, see <http://www.gnu.org/licenses>.
 *
 *  Additional permission under GNU GPL version 3 section 7:
 *
 *  KNIME interoperates with ECLIPSE solely via ECLIPSE's plug-in APIs.
 *  Hence, KNIME and ECLIPSE are both independent programs and are not
 *  derived from each other. Should, however, the interpretation of the
 *  GNU GPL Version 3 ("License") under any applicable laws result in
 *  KNIME and ECLIPSE being a combined program, KNIME AG herewith grants
 *  you the additional permission to use and propagate KNIME together with
 *  ECLIPSE with only the license terms in place for ECLIPSE applying to
 *  ECLIPSE and the GNU GPL Version 3 applying for KNIME, provided the
 *  license terms of ECLIPSE themselves allow for the respective use and
 *  propagation of ECLIPSE together with KNIME.
 *
 *  Additional permission relating to nodes for KNIME that extend the Node
 *  Extension (and in particular that are based on subclasses of NodeModel,
 *  NodeDialog, and NodeView) and that only interoperate with KNIME through
 *  standard APIs ("Nodes"):
 *  Nodes are deemed to be separate and independent programs and to not be
 *  covered works.  Notwithstanding anything to the contrary in the
 *  License, the License does not apply to Nodes, you are not required to
 *  license Nodes under the License, and you are granted a license to
 *  prepare and propagate Nodes, in each case even if such Nodes are
 *  propagated with or for interoperation with KNIME.  The owner of a Node
 *  may freely choose the license terms applicable to such Node, including
 *  when such Node is propagated with or for interoperation with KNIME.
 * ---------------------------------------------------------------------
 *
 * Created on Oct 1, 2013 by Patrick Winter
 */
package org.knime.core.node.util.filter.variable;

import java.util.Arrays;
import java.util.List;

import org.knime.core.node.util.FlowVariableListCellRenderer.FlowVariableCell;
import org.knime.core.node.util.filter.InputFilter;
import org.knime.core.node.workflow.FlowVariable;

/**
 * Class that filters FlowVariables based on the given set of FlowVariable.Types.
 *
 * @author Patrick Winter, KNIME AG, Zurich, Switzerland
 * @deprecated use {@link VariableTypeFilter} instead.
 * @since 2.9
 */
@Deprecated
public class FlowVariableTypeFilter extends InputFilter<FlowVariableCell> {

    private final FlowVariable.Type[] m_filterTypes;

    /**
     * Creates a new FlowVariableTypeFilter.
     *
     * @param filterValueTypes The types that are accepted
     */
    public FlowVariableTypeFilter(final FlowVariable.Type... filterValueTypes) {
        if (filterValueTypes == null || filterValueTypes.length == 0) {
            throw new NullPointerException("Types must not be null");
        }
        final List<FlowVariable.Type> list = Arrays.asList(filterValueTypes);
        if (list.contains(null)) {
            throw new NullPointerException("List of value types must not contain null elements.");
        }
        m_filterTypes = filterValueTypes;
    }

    /**
     * @param flowVariableCell The cell containing the flow variable
     * @return true if the flow variable cell should be included, false otherwise
     * @since 2.10
     */
    @Override
    public final boolean include(final FlowVariableCell flowVariableCell) {
        if (flowVariableCell.isValid()) {
            return include(flowVariableCell.getFlowVariable());
        }
        return true;
    }

    /**
     * @param flowVariable The flow variable to check
     * @return true if the flow variable should be included, false otherwise
     */
    public final boolean include(final FlowVariable flowVariable) {
        for (final FlowVariable.Type ty : m_filterTypes) {
            if (flowVariable.getType() == ty) {
                return true;
            }
        }
        return false;
    }

}
